/*
 * Copyright (c) 2020, yifengling0. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. No personal names or organizations' names associated with the
 *    Atomthreads project may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


#ifndef _DEVICE_KEYBOARD_H_
#define _DEVICE_KEYBOARD_H_

#include "device.h"

#ifdef __cplusplus
extern "C" {
#endif

#define LONG_PRESS_TIME     1500                   /*长按确认时间 ------------*/
#define KEY_DEBOUNCE_TIME   20                     /*按键消抖时间 ------------*/

#define KEY_PRESS           0                      /*短按 --------------------*/
#define KEY_LONG_DOWN       1                      /*长按按下 ----------------*/
#define KEY_LONG_UP         2                      /*长按释放 ----------------*/

	typedef struct Key_t Key_t;
	struct KeyOps;


	/*按键管理器 -----------------------------------------------------------------*/
	typedef struct Key_t {
		struct Key_t* next;                            /*连接下一个按键并构成链表 */
		struct {
			unsigned int tick;                             /*滴答计时器 --------------*/
			const struct KeyOps* ops;
			void* param;
		}Protected;
	}Key_t;

	typedef struct DeviceKeyboard DeviceKeyboard;

	typedef void (*KEYBOARD_EVENT)(DeviceKeyboard* dev, Key_t* key, int type, unsigned int duration);

	typedef struct keyboardOps
	{
		void (*enable)(DeviceKeyboard* dev);
		void (*disable)(DeviceKeyboard* dev);
		int  (*readkey)(DeviceKeyboard* dev, Key_t* key);
	}KeyboardOps;

	typedef struct DeviceKeyboard {
		Device_t super;
		struct {
			KEYBOARD_EVENT key_event;
			const KeyboardOps* ops;
		}Protected;
	}DeviceKeyboard;

	int DeviceKeyboardKeyCreate(Key_t* key);
	void DeviceKeyboardCreate(DeviceDesc* desc, KEYBOARD_EVENT key_event, const KeyboardOps* ops);
	void DeviceKeyScanProcess(void);

#ifdef __cplusplus
}
#endif

#endif